vcStatisticsTab

vcStatisticsTab is an object representing a tab listed in a Statistics dashboard and contains one or more charts which are organized in a grid.

See in: Overview

Module: vcCore

Parent: vcObject

Children -

Referenced by: vcStatisticsDashboard.SelectedTab, vcStatisticsDashboard.createTab()

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

Name	Type	Access	Description
Charts	list	R	Gets all the charts of tab.
Layouts	list	RW	Gets or sets the available layouts for tab grid. See more Each element in the list is a list with following content: First element is String layoutName. Next elements are Lists, each of which contains info about a single tile or placeholder. The tile info lists each contain these elements: String placeholder_name, Integer column, Integer row, Integer columnSpan, Integer rowSpan Exceptions: ValueError: When the given list contains an invalid value.
MaxColumns	Integer	R	Gets the maximum number of columns in tab grid.
MaxRows	Integer	R	Gets the maximum number of rows in tab grid.
Name	String	RW	Gets or sets the name of the tab.
SelectedChart	vcStatisticsChart	RW	Gets the active chart of tab.
SelectedLayout	object	R	Defines the attributes of SelectedLayout. See more First element of the list is String layoutName. Next elements are Lists, each of which contains info about a single tile or placeholder. The tile info lists each contain these elements: String placeholder_name, Integer column, Integer row, Integer columnSpan, Integer rowSpan.
SelectedLayoutIndex	Integer	RW	Gets the index of the current layout of tab grid. Exceptions: IndexError: When the given index is out of range.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

Name	Return Type	Parameters	Description
clearLayout	None	None	Deletes all charts from tab grid.
createChart	vcStatisticsChart	vcStatisticsChart chartLocation, vcChartType chartType, Optional Keyword[activate = Boolean]	Creates and adds a new chart of a given type to tab grid. See more Parameters: chartLocation (vcStatisticsChart): Specifies where in the grid to insert the new chart. In this context, the vcStatisticsChart object is a grid location. It can be a chart with existing data or an empty chart used as a placeholder. In either case, a call will remove the existing chart and exchange it with a new one in the grid. chartType (vcChartType): Type of the chart. Optional: activate (Boolean): Specifies if the new chart is set as the active chart in tab. Returns: vcStatisticsChart: The created chart.
createLayout	None	None	Creates a new layout for tab grid.
delete	None	None	Deletes this tab.